Generate and Print a ZMK Component

Command:

Generate a random ZMK component, print it at the HSM attached printer and return the encrypted value to the host.

Notes:

The HSM must be in the Authorised state.

A printer must be attached to the HSM Printer port or Auxiliary port.

The HSM must have a print format already defined.

The ESCON option does not return the second response message and its first response message is delayed until after printing has been completed. This is because the channel protocol allows only one response per request.

If a 32-character ZMK is required, the HSM must be configured for double-length ZMKs using the CS (Configure Security) console command.

The delimeter to separate optional fields is changed from “;” to “|”.

 

Field

Length & Type

Details

COMMAND MESSAGE

Message header

m A

(Subsequently returned to the Host unchanged).

Command code

2 A

Value OC.

Print Field 0

n A

The print field defined as Print Field 0 in the print format definition (must not contain a “;” character).

Delimiter

1 A

Value “;”

Print Field 1

n A

The print field defined as Print Field 1 in the print format definition (must not contain a “;” character).

.

.

.

Last print field

n A

The last print field defined in the print format definition must not contain a “;” character).

Delimiter

1 A

Optional. If present the following three fields must be present.  Value “|”.

If an option is not required by the command fill with a valid value or 0.

Key scheme ZMK

1 A

Optional. Key scheme for encrypting key under ZMK.

Key scheme LMK

1 A

Optional. Key scheme for encrypting key under LMK.

Key check value type

1 A

Optional. Key check value calculation method

0 - KCV backwards compatible.

1 - KCV 6H.

End message delimiter

1 C

Optional. Must be present if a message trailer is present. Value X’19.

Message trailer

n A

Optional. Maximum length 32 characters.


 

Field

Length & Type

Details

RESPONSE MESSAGE (before printing)

Message header

n A

Returned to the Host unchanged.

Response code

2 A

Value OD.

Error code

2 N

00 : No Error

13 : LMK error; report to supervisor

15 : Error in input data

16 : Printer not ready/not connected

17 : Not in the Authorized state

18 : Format definition not loaded

ZMK component

16H or 32H or 1A+32H

ZMK component encrypted under a variant of LMK pair 04-05.

End message delimiter

1 C

Present only if present in the command message. Value X’19.

Message trailer

n A

Present only if present in the command message. Maximum length 32 characters.

RESPONSE MESSAGE (after printing)

Message header

N A

Returned to the Host unchanged

Response code

2 A

Value OZ

Error code

2 N

00 : No errors

13 : LMK error, report to supervisor

16 : Printer not ready or disconnected

End message delimiter

1 C

Present only if present in the command message. Maximum length 32 characters